GetRowColumnCompressed(byte[],ushort[],int,int,int,int) Method

Summary

Retrieves a row (or part of a row) of 1-bit compressed data from an image that has been loaded in its compressed format.

Syntax

Objective-C

C++/CLI

Java

Python

[CLSCompliantAttribute(false)] 
public int GetRowColumnCompressed( 
   byte[] workBuffer, 
   ushort[] runBuffer, 
   int runBufferOffset, 
   int row, 
   int column, 
   int width 
)

- (NSInteger)getRowColumnCompressed:(unsigned char *)workBuffer  
                          runBuffer:(unsigned short *)runBuffer  
                                row:(NSInteger)row  
                             column:(NSInteger)column  
                              width:(NSUInteger)pixels  
                              error:(NSError **)error

public int getRowColumnCompressed( 
  byte[] workBuffer,  
  short[] runBuffer,  
  int runBufferOffset,  
  int row,  
  int column,  
  int width 
            )

[CLSCompliantAttribute(false)] 
public: 
int GetRowColumnCompressed(  
   array<byte>^ workBuffer, 
   array<ushort>^ runBuffer, 
   int runBufferOffset, 
   int row, 
   int column, 
   int width 
)

def GetRowColumnCompressed(self,workBuffer,runBuffer,runBufferOffset,row,column,width):

Parameters

workBuffer
Optional work buffer. Allocating the work buffer speeds processing if you call this method more than once, because if you do not allocate a work buffer, the method allocates and frees a temporary buffer each time it is called. The size of this buffer should be the same as the BytesPerLine property. Pass a null reference to runBuffer if you do not want to use a work buffer.

runBuffer
The output buffer, which will be filled with 1-bit compressed image data. Calculate the required size of this buffer as follows: bytes required = (Width + 3) * 2.

runBufferOffset
Index into runBuffer where the get operation should start.

row
The number of the row to retrieve. The first row is 0, and the last row is 1 less than the image height.

column
The column offset within the row to retrieve. The first column offset is 0, and the last column offset is 1 less than the image width.

width
The number of pixels to retrieve.

Return Value

The number of pixels processed.

Remarks

This method is available in the (Document/Medical only).

This method is useful for working with 1-bit images that are loaded in their compressed formats for faster loading and display.

For more information, refer to Speeding Up 1-Bit Documents.

Example

This example demonstrates the low-level methods for accessing 1-bit compressed bitmap data. It demonstrates the ability to get and set partial rows, and the ability to process partial rows in buffer-to-buffer processing. The result of the method is an inverted rectangle in the middle of the image.

Requirements

Target Platforms

Reference

RasterImage Class

RasterImage Members

Overload List

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools Assembly

Introduction

Getting Started

Namespaces

Leadtools Namespace

Leadtools.ImageProcessing Namespace

Assemblies